<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class IAdjustment</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface IAdjustment</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A type that represents a pair of an <a href="../sde_fastsearch_result/IModifier.html">IModifier</a> and a <a href="../sde_fastsearch_navigation/ModifyMode.html">ModifyMode</a>.</p>
<p class="description"><p>Used as components of <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a>s in and <a href="../sde_fastsearch_navigation/INavigation.html">INavigation</a>.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: IAdjustment.html 14 2009-08-23 04:31:36Z andreas.scheerer $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---navigation---IAdjustment.php.html">/src/sde/fastsearch/navigation/IAdjustment.php</a> (line <span class="field">31</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																						
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a></span>
										<a href="#getAdjustmentGroup" title="details" class="method-name">getAdjustmentGroup</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getFilterTerm" title="details" class="method-name">getFilterTerm</a>
											([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$includePrefix</span> = <span class="var-default">true</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getIndex" title="details" class="method-name">getIndex</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_result/IModifier.html">IModifier</a></span>
										<a href="#getModifier" title="details" class="method-name">getModifier</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getModifierName" title="details" class="method-name">getModifierName</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getModifierValue" title="details" class="method-name">getModifierValue</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getModifyMode" title="details" class="method-name">getModifyMode</a>
										()
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetAdjustmentGroup" id="getAdjustmentGroup"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getAdjustmentGroup</span> (line <span class="line-number">37</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a> of this adjustment.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a></span>
		<span class="method-name">
			getAdjustmentGroup
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetFilterTerm" id="getFilterTerm"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getFilterTerm</span> (line <span class="line-number">45</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the filter term produced by this adjustment alone,  with optional +/- prefix.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getFilterTerm
		</span>
					([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$includePrefix</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$includePrefix</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetIndex" id="getIndex"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getIndex</span> (line <span class="line-number">51</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the index of this adjustment in its <a href="../sde_fastsearch_navigation/IAdjustmentGroup.html">IAdjustmentGroup</a>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getIndex
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetModifier" id="getModifier"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getModifier</span> (line <span class="line-number">57</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the <a href="../sde_fastsearch_result/IModifier.html">IModifier</a> of this adjustment.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_result/IModifier.html">IModifier</a></span>
		<span class="method-name">
			getModifier
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetModifierName" id="getModifierName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getModifierName</span> (line <span class="line-number">63</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the modifier name of this adjustment.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getModifierName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetModifierValue" id="getModifierValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getModifierValue</span> (line <span class="line-number">69</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the modifier value of this adjustment.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getModifierValue
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetModifyMode" id="getModifyMode"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getModifyMode</span> (line <span class="line-number">75</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the <a href="../sde_fastsearch_navigation/ModifyMode.html">ModifyMode</a> for this adjustment.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getModifyMode
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:30:07 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>